<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>nandps: xnandps.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.gif"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">nandps
   </div>
   <div id="projectbrief">Xilinx SDK Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xnandps_8c.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a>  </div>
  <div class="headertitle">
<div class="title">xnandps.c File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gae2862ccd7e9180b843d9e73e2a8c7e7b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nandps__v2__2.html#gae2862ccd7e9180b843d9e73e2a8c7e7b">XNandPs_SendCommand</a> (<a class="el" href="group__nandps__v2__2.html#gaf0def4ad29325b821b3fd4127740dfbe">XNandPs</a> *InstancePtr, <a class="el" href="struct_x_nand_ps___command_format.html">XNandPs_CommandFormat</a> *Command, int Page, int Column)</td></tr>
<tr class="memdesc:gae2862ccd7e9180b843d9e73e2a8c7e7b"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends a NAND command to the flash device.  <a href="group__nandps__v2__2.html#gae2862ccd7e9180b843d9e73e2a8c7e7b">More...</a><br /></td></tr>
<tr class="separator:gae2862ccd7e9180b843d9e73e2a8c7e7b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga92acb0aedbfa7e76759062d70a2c4a67"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nandps__v2__2.html#ga92acb0aedbfa7e76759062d70a2c4a67">XNandPs_InitBbtDesc</a> (<a class="el" href="group__nandps__v2__2.html#gaf0def4ad29325b821b3fd4127740dfbe">XNandPs</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga92acb0aedbfa7e76759062d70a2c4a67"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function initializes the Bad Block Table(BBT) descriptors with a predefined pattern for searching Bad Block Table(BBT) in flash.  <a href="group__nandps__v2__2.html#ga92acb0aedbfa7e76759062d70a2c4a67">More...</a><br /></td></tr>
<tr class="separator:ga92acb0aedbfa7e76759062d70a2c4a67"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga454c0738c0ffe28c49ba8fced47e8d9c"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nandps__v2__2.html#ga454c0738c0ffe28c49ba8fced47e8d9c">XNandPs_ScanBbt</a> (<a class="el" href="group__nandps__v2__2.html#gaf0def4ad29325b821b3fd4127740dfbe">XNandPs</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga454c0738c0ffe28c49ba8fced47e8d9c"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function reads the Bad Block Table(BBT) if present in flash.  <a href="group__nandps__v2__2.html#ga454c0738c0ffe28c49ba8fced47e8d9c">More...</a><br /></td></tr>
<tr class="separator:ga454c0738c0ffe28c49ba8fced47e8d9c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7f3a46694f4b3c4baffca71e6fcfebab"><td class="memItemLeft" align="right" valign="top">u8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nandps__v2__2.html#ga7f3a46694f4b3c4baffca71e6fcfebab">Onfi_CmdReadStatus</a> (<a class="el" href="group__nandps__v2__2.html#gaf0def4ad29325b821b3fd4127740dfbe">XNandPs</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga7f3a46694f4b3c4baffca71e6fcfebab"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends read status command to the flash device.  <a href="group__nandps__v2__2.html#ga7f3a46694f4b3c4baffca71e6fcfebab">More...</a><br /></td></tr>
<tr class="separator:ga7f3a46694f4b3c4baffca71e6fcfebab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gacb42515d1fa541b8ac5e785d1fb7eefd"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nandps__v2__2.html#gacb42515d1fa541b8ac5e785d1fb7eefd">Onfi_NandInit</a> (<a class="el" href="group__nandps__v2__2.html#gaf0def4ad29325b821b3fd4127740dfbe">XNandPs</a> *InstancePtr)</td></tr>
<tr class="memdesc:gacb42515d1fa541b8ac5e785d1fb7eefd"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function initializes the NAND flash and gets the geometry information.  <a href="group__nandps__v2__2.html#gacb42515d1fa541b8ac5e785d1fb7eefd">More...</a><br /></td></tr>
<tr class="separator:gacb42515d1fa541b8ac5e785d1fb7eefd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaddb9f847fae34f6d137f591375a7c962"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nandps__v2__2.html#gaddb9f847fae34f6d137f591375a7c962">XNandPs_CfgInitialize</a> (<a class="el" href="group__nandps__v2__2.html#gaf0def4ad29325b821b3fd4127740dfbe">XNandPs</a> *InstancePtr, <a class="el" href="struct_x_nand_ps___config.html">XNandPs_Config</a> *ConfigPtr, u32 SmcBaseAddr, u32 FlashBaseAddr)</td></tr>
<tr class="memdesc:gaddb9f847fae34f6d137f591375a7c962"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function initializes a specific XNandPs device/instance.  <a href="group__nandps__v2__2.html#gaddb9f847fae34f6d137f591375a7c962">More...</a><br /></td></tr>
<tr class="separator:gaddb9f847fae34f6d137f591375a7c962"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8e72425d265074f1c2f8c66edfd22857"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nandps__v2__2.html#ga8e72425d265074f1c2f8c66edfd22857">XNandPs_Read</a> (<a class="el" href="group__nandps__v2__2.html#gaf0def4ad29325b821b3fd4127740dfbe">XNandPs</a> *InstancePtr, u64 Offset, u32 Length, void *DestPtr, u8 *UserSparePtr)</td></tr>
<tr class="memdesc:ga8e72425d265074f1c2f8c66edfd22857"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function reads the data from the Flash device and copies it into the specified user buffer.  <a href="group__nandps__v2__2.html#ga8e72425d265074f1c2f8c66edfd22857">More...</a><br /></td></tr>
<tr class="separator:ga8e72425d265074f1c2f8c66edfd22857"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga605bd783f065806f1d1f602f88128f9b"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nandps__v2__2.html#ga605bd783f065806f1d1f602f88128f9b">XNandPs_ReadCache</a> (<a class="el" href="group__nandps__v2__2.html#gaf0def4ad29325b821b3fd4127740dfbe">XNandPs</a> *InstancePtr, u64 Offset, u32 Length, void *DestPtr, u8 *UserSparePtr)</td></tr>
<tr class="memdesc:ga605bd783f065806f1d1f602f88128f9b"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function reads the data from the Flash device using read page cache command and copies it into the specified user buffer.  <a href="group__nandps__v2__2.html#ga605bd783f065806f1d1f602f88128f9b">More...</a><br /></td></tr>
<tr class="separator:ga605bd783f065806f1d1f602f88128f9b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaebab330d0fd9efef74c26a50b5829d9f"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nandps__v2__2.html#gaebab330d0fd9efef74c26a50b5829d9f">XNandPs_Write</a> (<a class="el" href="group__nandps__v2__2.html#gaf0def4ad29325b821b3fd4127740dfbe">XNandPs</a> *InstancePtr, u64 Offset, u32 Length, void *SrcPtr, u8 *UserSparePtr)</td></tr>
<tr class="memdesc:gaebab330d0fd9efef74c26a50b5829d9f"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function programs the flash device(s) with data specified in the user buffer.  <a href="group__nandps__v2__2.html#gaebab330d0fd9efef74c26a50b5829d9f">More...</a><br /></td></tr>
<tr class="separator:gaebab330d0fd9efef74c26a50b5829d9f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8ecd5bb0fc73b3011ee0ba500e0161fe"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nandps__v2__2.html#ga8ecd5bb0fc73b3011ee0ba500e0161fe">XNandPs_WriteCache</a> (<a class="el" href="group__nandps__v2__2.html#gaf0def4ad29325b821b3fd4127740dfbe">XNandPs</a> *InstancePtr, u64 Offset, u32 Length, void *SrcPtr, u8 *UserSparePtr)</td></tr>
<tr class="memdesc:ga8ecd5bb0fc73b3011ee0ba500e0161fe"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function programs the flash device(s) with data specified in the user buffer using program cache command.  <a href="group__nandps__v2__2.html#ga8ecd5bb0fc73b3011ee0ba500e0161fe">More...</a><br /></td></tr>
<tr class="separator:ga8ecd5bb0fc73b3011ee0ba500e0161fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf9857df5e1359875e429f66e46ca5a86"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nandps__v2__2.html#gaf9857df5e1359875e429f66e46ca5a86">XNandPs_ReadSpareBytes</a> (<a class="el" href="group__nandps__v2__2.html#gaf0def4ad29325b821b3fd4127740dfbe">XNandPs</a> *InstancePtr, u32 Page, u8 *Buf)</td></tr>
<tr class="memdesc:gaf9857df5e1359875e429f66e46ca5a86"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function reads the spare area of a page.  <a href="group__nandps__v2__2.html#gaf9857df5e1359875e429f66e46ca5a86">More...</a><br /></td></tr>
<tr class="separator:gaf9857df5e1359875e429f66e46ca5a86"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa987d756af43c965a6439f077a4ce158"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nandps__v2__2.html#gaa987d756af43c965a6439f077a4ce158">XNandPs_WriteSpareBytes</a> (<a class="el" href="group__nandps__v2__2.html#gaf0def4ad29325b821b3fd4127740dfbe">XNandPs</a> *InstancePtr, u32 Page, u8 *Buf)</td></tr>
<tr class="memdesc:gaa987d756af43c965a6439f077a4ce158"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function write to the spare area of a page.  <a href="group__nandps__v2__2.html#gaa987d756af43c965a6439f077a4ce158">More...</a><br /></td></tr>
<tr class="separator:gaa987d756af43c965a6439f077a4ce158"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga22b4e2bc1af7e4bfecd4428c25a77bb8"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nandps__v2__2.html#ga22b4e2bc1af7e4bfecd4428c25a77bb8">XNandPs_EraseBlock</a> (<a class="el" href="group__nandps__v2__2.html#gaf0def4ad29325b821b3fd4127740dfbe">XNandPs</a> *InstancePtr, u32 BlockNum)</td></tr>
<tr class="memdesc:ga22b4e2bc1af7e4bfecd4428c25a77bb8"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function erases a specific block in the NAND device.  <a href="group__nandps__v2__2.html#ga22b4e2bc1af7e4bfecd4428c25a77bb8">More...</a><br /></td></tr>
<tr class="separator:ga22b4e2bc1af7e4bfecd4428c25a77bb8"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:gae980af68044391bcf0c94bd2b35c910b"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nandps__v2__2.html#gae980af68044391bcf0c94bd2b35c910b">NandOob16</a> [] = {13, 14, 15}</td></tr>
<tr class="memdesc:gae980af68044391bcf0c94bd2b35c910b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Ecc position for 16 bytes spare area.  <a href="group__nandps__v2__2.html#gae980af68044391bcf0c94bd2b35c910b">More...</a><br /></td></tr>
<tr class="separator:gae980af68044391bcf0c94bd2b35c910b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad8d144dd94afdb026486d7b34e6c58f1"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nandps__v2__2.html#gad8d144dd94afdb026486d7b34e6c58f1">NandOob32</a> [] = {26, 27, 28, 29, 30, 31}</td></tr>
<tr class="memdesc:gad8d144dd94afdb026486d7b34e6c58f1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Ecc position for 32 bytes spare area.  <a href="group__nandps__v2__2.html#gad8d144dd94afdb026486d7b34e6c58f1">More...</a><br /></td></tr>
<tr class="separator:gad8d144dd94afdb026486d7b34e6c58f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaed173a3e7bda0d3a84e8f7d55aa4e81d"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nandps__v2__2.html#gaed173a3e7bda0d3a84e8f7d55aa4e81d">NandOob64</a> []</td></tr>
<tr class="memdesc:gaed173a3e7bda0d3a84e8f7d55aa4e81d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Ecc position for 64 bytes spare area.  <a href="group__nandps__v2__2.html#gaed173a3e7bda0d3a84e8f7d55aa4e81d">More...</a><br /></td></tr>
<tr class="separator:gaed173a3e7bda0d3a84e8f7d55aa4e81d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6256f01deb0ca40af90a3b6ceb0aef94"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_nand_ps___command_format.html">XNandPs_CommandFormat</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nandps__v2__2.html#ga6256f01deb0ca40af90a3b6ceb0aef94">OnfiCommands</a> []</td></tr>
<tr class="memdesc:ga6256f01deb0ca40af90a3b6ceb0aef94"><td class="mdescLeft">&#160;</td><td class="mdescRight">ONFI commands.  <a href="group__nandps__v2__2.html#ga6256f01deb0ca40af90a3b6ceb0aef94">More...</a><br /></td></tr>
<tr class="separator:ga6256f01deb0ca40af90a3b6ceb0aef94"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">Copyright &copy; 2015 Xilinx Inc. All rights reserved.</li>
  </ul>
</div>
</body>
</html>
